home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 25 / Cream of the Crop 25.iso / windows / comnt11.zip / OVERVIEW.TXT < prev    next >
Text File  |  1997-03-29  |  13KB  |  275 lines
  1.  
  2.  
  3.  
  4.  
  5.          OVERVIEW
  6.  
  7.          Easy Software's Commentator allows you to associate text
  8.          comments with any file and to search for text in your comments.
  9.          When Commentator finds the text you have searched for it also
  10.          finds the associated file. You can then launch any application
  11.          with that file name on the command line.  Commentator is
  12.          suitable for any application which accepts a workfile on the
  13.          command line such as Word Processors, CAD, Desktop Publishers,
  14.          Midi Editors Etc.
  15.  
  16.          SETTING UP YOUR APPLICATIONS
  17.  
  18.          When you first start Commentator, click the "Setup Applications"
  19.          button. The setup window has the following fields:-
  20.  
  21.          Application Name
  22.  
  23.          This is the name that will be shown on the application launch
  24.          button. Eg. Autocad, MS Publisher, Cubasis Etc.
  25.  
  26.          Application Executable
  27.  
  28.          This is the full path and filename of the application to launch.
  29.          There is a browse button.
  30.  
  31.          File Filter
  32.  
  33.          This is the filter to use with the application. For example:-
  34.          *.MID for Midi applications, *.PUB for Desktop publishing. You
  35.          can have multiple filters by separating them with a semi-colon.
  36.          For Example, a word processor might have the filter:-
  37.          *.txt;*.bat;*.ini
  38.  
  39.          Working Directory
  40.  
  41.          This is the directory which Commentator will make current when
  42.          it launches your application. This defaults to the application's
  43.          directory. You can select "Work File Directory" in which case
  44.          Commentator will make the directory of the work file you choose
  45.          current. If you want another directory to be current, choose
  46.          "Custom" and type in the directory name.
  47.  
  48.          DOS Applications
  49.  
  50.          If your application is DOS you can choose to have Commentator
  51.          call direct to the application name or to create a PIF file
  52.          either for full screen or a DOS box. The PIF files which
  53.          Commentator creates have default values for everything except
  54.          the full screen/DOS box options. If your application requires a
  55.          PIF with non default values then set the DOS option to "Call
  56.          Direct" and use your PIF name in the Application Executable
  57.          field.
  58.  
  59.  
  60.          Additional Parameter
  61.  
  62.          If you need to call your application with command line switches
  63.          other than the filename to edit, you can enter them here and
  64.          Commentator will append them to the command line after the
  65.          chosen work file.
  66.  
  67.          First Directory to Search
  68.  
  69.          This is the directory in which Commentator will start when this
  70.          application is selected. Set it to the directory which contains
  71.          your current work files for the application. There is a browse
  72.          button to select with.
  73.  
  74.          Launch App Maximized
  75.  
  76.          By default, Commentator will launch your application in a normal
  77.          window. Check this option to launch maximized. ( Some
  78.          applications override this option)
  79.  
  80.          Minimize on Use
  81.  
  82.          Most editing applications use the full screen so you can
  83.          normally leave this unchecked and Commentator will be ready for
  84.          use when you close the application. If the application is not
  85.          full screen you can check this and Commentator will minimize
  86.          after launching the application.
  87.  
  88.          Unload on Use
  89.  
  90.          If the application requires all available memory, check this
  91.          option and Commentator will unload after launching it. (This
  92.          option may not work with some 32 bit applications)
  93.  
  94.          Save Modify Exit
  95.  
  96.          When you have filled all the fields, click the Save button. You
  97.          can set up more applications now or you can click the Exit
  98.          button to return to the main screen. To edit the settings for an
  99.          application, click the Modify button, select the application and
  100.          edit the fields. You can delete an application by clicking the
  101.          Delete button which appears to the right of the application name
  102.          after selecting "Modify".
  103.  
  104.          Password         
  105.  
  106.          If you administer several PCs you may not wish users to alter
  107.          your setup. You can password protect the setup and purge buttons
  108.          by clicking the password button.         
  109.  
  110.          When you return to the main window, you will notice that the
  111.          launch button has turned red and contains the name of the last
  112.          application you setup and that the directory/file boxes are set
  113.          to the directory you chose as the first directory to search.
  114.          If you have setup more than one application you can switch
  115.          between them by clicking the Change Application Button.
  116.  
  117.   
  118.  
  119.          COMMENTING YOUR FILES
  120.  
  121.          There are two comment entry fields. One for directory comments
  122.          and one for file comments. They accepts a maximum of 176
  123.          characters. Type in the comment you wish to associate with the
  124.          highlighted file or directory and click the Save Comment button
  125.          or press F2 ( All main buttons have function key alternatives
  126.          if you prefer not to reach for the mouse) Your comment will now
  127.          appear in the comment box whenever this file is highlighted.
  128.          You can edit your comments at any time and re-save them with F2.
  129.          You can paste text from the clipboard into comment fields by
  130.          pressing Shift+Ins and you can cut or copy text from the comment
  131.          fields by selecting the text and right clicking for the Edit Menu.
  132.  
  133.          SEARCHING YOUR COMMENTS
  134.  
  135.          To search your comments, enter search text in the search field
  136.          immediately below the Comment boxes and press return, F4 or click
  137.          the Search button. If no match is found, Commentator will beep.
  138.          If a match is found but it is not associated with the file you
  139.          want, press return again without changing the search text and
  140.          Commentator will find the next match.
  141.  
  142.          When you have found the file you want, click the red launch
  143.          button to start the application with the selected file.
  144.  
  145.          There are options to search the highlighted directory or all
  146.          directories. The All directories option is sensible if you have
  147.          a limited number of commented files which are scattered
  148.          throughout several directories. However, indexing the comments
  149.          for a directory can take time. (Indexing a directory with 1000
  150.          comments on a pentium 120 takes 4-5 seconds) If you know which
  151.          directory the file you are looking for is in you can speed the
  152.          search by pre-selecting that directory and using the "This
  153.          Directory" search option. If you have many commented directories
  154.          You can search the directory comments by clicking the Directories
  155.          only button.
  156.  
  157.  
  158.          COMMENT STORAGE
  159.  
  160.          The comments you save are not attached in any way to the files
  161.          to which they relate. They are stored in files named COMMENT.DAT
  162.          There is one COMMENT.DAT file in each directory which contains
  163.          commented files. You should backup these files along with the
  164.          files to which they relate. If you erase COMMENT.DAT you have
  165.          lost your comments !  The Multi User version also creates two
  166.          small files, COMMENT.LOC and COMMENT.UPD in each commented
  167.          directory. These files are only required while workstations
  168.          are using Commentator.
  169.  
  170.          A list of the directories with COMMENT.DAT files is stored in
  171.          COMMENT.DRS in the Commentator directory. COMMENT.DRS is plain
  172.          ASCII so you can view it with any text editor. COMMENT.DRS is
  173.          used when you search with the "All Directories" option so do not
  174.          delete it.
  175.  
  176.          When you delete files for which you have saved comments, the
  177.          comments themselves are not deleted. Commentator will remove
  178.          comments for files which no longer exist when you click the
  179.          Purge Deleted Comments button.  If you have a large number of
  180.          comments, purging can take a considerable time. There is no need
  181.          to diligently purge whenever you delete a file but as the number
  182.          of redundant comments grows, so the indexing and search routines
  183.          will slow down.  Occasional purging will rectify this as well as
  184.          free up disk space.
  185.  
  186.          LIMITATIONS
  187.  
  188.          There is no limitation on the total number of comments. The
  189.          number of comments which can be indexed for one directory is
  190.          limited by memory. Commentator has been tested to 1000 commented
  191.          files per directory under Windows 3.1 and 95.
  192.  
  193.          NETWORK INSTALLATIONS
  194.  
  195.          The recommended configuration for network use is a separate
  196.          copy of Commentator Multi User on the local drive of each
  197.          work station which will be using it.  This produces the minimum
  198.          network traffic and allows each work station to have it's own
  199.          application setup file.  You can install a single copy of 
  200.          Commentator on the server for use by all work stations but this
  201.          is not recommended. If you do this, all workstations will share
  202.          the same setup and default screen colors. If the server is also
  203.          used as a work station, there is a further complication in the
  204.          fact that any application on the server will have to be set up
  205.          twice as the server will reference it by its local drive letter
  206.          and all other workstations will reference it by the network drive
  207.          letter.
  208.           
  209.          If you purchase the Multi User version of Commentator, Your
  210.          license allows you to install copies on any number of work
  211.          stations on a single LAN. You only need multiple licenses to
  212.          use it on multiple local area networks.
  213.  
  214.          If you purchase the single user version of Commentator, your
  215.          licence is for a single CPU.  There are no locking facilities
  216.          in the single user. If you run two copies of the single user
  217.          on a local area network, you will get all sorts of problems.
  218.  
  219.          The evaluation (Shareware) version is Multi User.
  220.  
  221.  
  222.          PROBLEMS
  223.  
  224.          Searching all directories no longer finds comments in a directory.
  225.  
  226.          If, when searching all directories, Commentator cannot find one
  227.          of the directories in COMMENT.DRS, it assumes that the directory
  228.          has been erased and removes its entry from COMMENT.DRS. If the
  229.          reason for not finding that directory was that it was on a 
  230.          removable drive or was on a network drive which was temporarily
  231.          disconnected you will get this problem the next time the drive
  232.          is connected. To rectify it, just log to that directory and
  233.          re-save any one of your comments.
  234.  
  235.  
  236.  
  237.          EVALUATION LICENSE
  238.  
  239.          If this is an evaluation copy, you are licensed to use it for
  240.          thirty days only. If you wish to continue using Commentator
  241.          beyond the evaluation period, you must purchase a registered
  242.          copy.  If you continue to use the evaluation copy beyond the
  243.          evaluation period, it will remind you of this obligation. At
  244.          no time, however, will it cease to function or erase any of
  245.          your comment data. 
  246.  
  247.          Full copies of Commentator cost:- $40 Single User
  248.                                            $150 Multi User
  249.  
  250.          Site Licenses are also available.
  251.  
  252.          A site licence consists of a single copy of the software
  253.          together with a licence to duplicate and use that software on
  254.          multiple machines. Copies made under a site licenses are for 
  255.          in-house use by the licensee and may not be resold. To calculate
  256.          a site licence price, multiply the price for a single copy by the
  257.          number of copies required and apply the following discounts:
  258.  
  259.          2          40%
  260.          3-7        60%
  261.          10-16      70%
  262.          25-56      80%
  263.          75-133     85%
  264.          200-500    90%
  265.          1000+      95%
  266.  
  267.  
  268.  
  269.          Note:
  270.  
  271.          If you install a copy of Commentator on a workstation with
  272.          access to directories on a network drive which have already
  273.          been commented, the all directories search will not work
  274.          until you have saved a comment in each directory from the 
  275.          workstation.